/*
 * @(#)FloodFill.java     14/08/02
 * 
 * Author             Rick Wilson
 * Copyright (c) 2014 Rick Wilson
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of 'Taareekah' nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */



package util;

//~--- JDK imports ------------------------------------------------------------

import java.util.ArrayList;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Queue;
import java.util.Set;

/**
 *
 * @author rick
 */
public class FloodFill {

    /**
     *
     * @param start
     * @param function
     * @param size
     * @return
     */
    public List<Point> performFloodFile(Point start, FloodFillFunction function, int size) {
	Set<Point>	closed_set	= new HashSet<>();
	Queue<Point>	open_list	= new LinkedList<>();
	List<Point>	filled_list	= new ArrayList<>();

	open_list.add(start);

	while (open_list.size() > 0) {
	    Point	cur_point	= open_list.poll();

	    closed_set.add(cur_point);

	    if (!function.fillThisPoint(cur_point)) {
		continue;
	    }

	    filled_list.add(cur_point);

	    for (Point p : cur_point.getNeighborsWithinRange(0, size)) {
		if (!closed_set.contains(p) &&!open_list.contains(p)) {
		    open_list.add(p);
		}
	    }
	}

	return filled_list;
    }

    /**
     *
     */
    public abstract class FloodFillFunction {

	/**
	 *
	 * @param p
	 * @return
	 */
	public abstract boolean fillThisPoint(Point p);
    }
}


//~ Formatted by Jindent --- http://www.jindent.com
